DigiOffice Gateway Web Services

<back to all web services

ProcessDocumentRequestMessage

export class Environment
{
    public Title: string;
    public Code: string;

    public constructor(init?: Partial<Environment>) { (Object as any).assign(this, init); }
}

export class Party
{
    public Title: string;
    public Code: string;
    public Version: string;
    public Environment: Environment;

    public constructor(init?: Partial<Party>) { (Object as any).assign(this, init); }
}

export class Header
{
    public MessageID: string;
    public Timestamp: string;
    public Sender: Party;
    public Recipient: Party;
    public RequestMessageID: Object;

    public constructor(init?: Partial<Header>) { (Object as any).assign(this, init); }
}

export enum eventType
{
    Update = 'Update',
    Create = 'Create',
    Delete = 'Delete',
    Response = 'Response',
}

export class Document implements ICustomProperties
{
    public ID: string;
    public RootDocumentID: string;
    public RegistrationprofileID: string;
    public Title: string;
    public FullTitle: string;
    public Number: string;
    public Version: string;
    public ExternalNumber: string;
    public ExternalVersion: string;
    public InternalNumber: string;
    public InternalInvoiceNumber: string;
    public PersonID: number;
    public RelationID: number;
    public RelationTitle: string;
    public ProjectID: number;
    public ProjectTitle: string;
    public Extension: string;
    public Date?: string;
    public CommentsCount: number;
    public HasComments: boolean;
    public HasPreview: boolean;
    public ExtraField: string;
    public IsFavorite: boolean;
    public DocumentcategoryText: string;
    public FileSize?: number;
    public FileDate?: string;
    public Hash: string;
    public HashType: string;
    public FileUrl: string;
    public StandardDocumentUrl: string;
    public IsCorporateIdentity: boolean;
    public UserTitle: string;
    public IsFrozen: boolean;
    public InternalCompanyID: number;
    public DirectUrl: string;
    public AllowDigitalSigningOnlyOnPrimaryVersions: boolean;
    public IsPrimaryVersion: boolean;
    public FileExtension: string;
    public CustomProperties: { [index: string]: Object; };

    public constructor(init?: Partial<Document>) { (Object as any).assign(this, init); }
}

export class DocumentMessage
{
    public Header: Header;
    public EventType: eventType;
    public Document: Document;

    public constructor(init?: Partial<DocumentMessage>) { (Object as any).assign(this, init); }
}

export class DocumentRequestMessage
{
    public Header: Header;
    public RootDocumentID: string;
    public IncludePhysicalFile: boolean;

    public constructor(init?: Partial<DocumentRequestMessage>) { (Object as any).assign(this, init); }
}

export class ProcessDocumentRequestMessage
{
    public InstanceId: string;
    public DocumentRequest: DocumentRequestMessage;

    public constructor(init?: Partial<ProcessDocumentRequestMessage>) { (Object as any).assign(this, init); }
}

TypeScript ProcessDocumentRequestMessage DTOs

POST /xml/reply/ProcessDocumentRequestMessage HTTP/1.1 
Host: kpm_digiofficeapigateway.tbi.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProcessDocumentRequestMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigiOffice.Integration.TBIXchangeAzure.Messages">
  <DocumentRequest>
    <Header>
      <MessageID>String</MessageID>
      <Recipient>
        <Code>String</Code>
        <Environment>
          <Code>String</Code>
          <Title>String</Title>
        </Environment>
        <Title>String</Title>
        <Version>String</Version>
      </Recipient>
      <RequestMessageID />
      <Sender>
        <Code>String</Code>
        <Environment>
          <Code>String</Code>
          <Title>String</Title>
        </Environment>
        <Title>String</Title>
        <Version>String</Version>
      </Sender>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
    </Header>
    <IncludePhysicalFile>false</IncludePhysicalFile>
    <RootDocumentID>String</RootDocumentID>
  </DocumentRequest>
  <InstanceId>00000000-0000-0000-0000-000000000000</InstanceId>
</ProcessDocumentRequestMessage>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigiOffice.Integration.TBIXchangeAzure.Messages">
  <Document>
    <Code>String</Code>
    <ConstructionBlockReference>
      <GlobalID>String</GlobalID>
      <Title>String</Title>
    </ConstructionBlockReference>
    <ConstructionNumberReference>
      <GlobalID>String</GlobalID>
      <Title>String</Title>
    </ConstructionNumberReference>
    <CreatedBy>String</CreatedBy>
    <CreationDate>0001-01-01T00:00:00</CreationDate>
    <CustomFields>
      <CustomField>
        <Name>String</Name>
        <Value>String</Value>
      </CustomField>
    </CustomFields>
    <DeletedDate>0001-01-01T00:00:00</DeletedDate>
    <DeletedDateSpecified>false</DeletedDateSpecified>
    <DocumentTypeReference>
      <GlobalID>String</GlobalID>
      <Title>String</Title>
    </DocumentTypeReference>
    <File>
      <Content>String</Content>
      <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
      <Name>String</Name>
      <Size>0</Size>
      <Type>String</Type>
    </File>
    <Floor>0</Floor>
    <FloorSpecified>false</FloorSpecified>
    <GlobalID>String</GlobalID>
    <HousingTypeReference>
      <GlobalID>String</GlobalID>
      <Title>String</Title>
    </HousingTypeReference>
    <ModifiedBy>String</ModifiedBy>
    <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
    <NewestVersion>false</NewestVersion>
    <ProjectReference>
      <GlobalID>String</GlobalID>
      <Title>String</Title>
    </ProjectReference>
    <RelationReference>
      <GlobalID>String</GlobalID>
      <Title>String</Title>
    </RelationReference>
    <RootDocumentID>String</RootDocumentID>
    <Subject>String</Subject>
    <VersionNumber>String</VersionNumber>
  </Document>
  <EventType>Update</EventType>
  <Header>
    <MessageID>String</MessageID>
    <Recipient>
      <Code>String</Code>
      <Environment>
        <Code>String</Code>
        <Title>String</Title>
      </Environment>
      <Title>String</Title>
      <Version>String</Version>
    </Recipient>
    <RequestMessageID />
    <Sender>
      <Code>String</Code>
      <Environment>
        <Code>String</Code>
        <Title>String</Title>
      </Environment>
      <Title>String</Title>
      <Version>String</Version>
    </Sender>
    <Timestamp>0001-01-01T00:00:00</Timestamp>
  </Header>
</DocumentMessage>